home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / libraries / mui20dev.lha / MUI / Developer / Autodocs / MUI_Window.doc < prev    next >
Text File  |  1994-02-11  |  22KB  |  856 lines
  1. TABLE OF CONTENTS
  2.  
  3. Window.mui/Window.mui
  4. Window.mui/MUIM_Window_GetMenuCheck
  5. Window.mui/MUIM_Window_GetMenuState
  6. Window.mui/MUIM_Window_ScreenToBack
  7. Window.mui/MUIM_Window_ScreenToFront
  8. Window.mui/MUIM_Window_SetCycleChain
  9. Window.mui/MUIM_Window_SetMenuCheck
  10. Window.mui/MUIM_Window_SetMenuState
  11. Window.mui/MUIM_Window_ToBack
  12. Window.mui/MUIM_Window_ToFront
  13. Window.mui/MUIA_Window_Activate
  14. Window.mui/MUIA_Window_ActiveObject
  15. Window.mui/MUIA_Window_AltHeight
  16. Window.mui/MUIA_Window_AltLeftEdge
  17. Window.mui/MUIA_Window_AltTopEdge
  18. Window.mui/MUIA_Window_AltWidth
  19. Window.mui/MUIA_Window_AppWindow
  20. Window.mui/MUIA_Window_Backdrop
  21. Window.mui/MUIA_Window_Borderless
  22. Window.mui/MUIA_Window_CloseGadget
  23. Window.mui/MUIA_Window_CloseRequest
  24. Window.mui/MUIA_Window_DefaultObject
  25. Window.mui/MUIA_Window_DepthGadget
  26. Window.mui/MUIA_Window_DragBar
  27. Window.mui/MUIA_Window_Height
  28. Window.mui/MUIA_Window_ID
  29. Window.mui/MUIA_Window_InputEvent
  30. Window.mui/MUIA_Window_LeftEdge
  31. Window.mui/MUIA_Window_Menu
  32. Window.mui/MUIA_Window_NoMenus
  33. Window.mui/MUIA_Window_Open
  34. Window.mui/MUIA_Window_PublicScreen
  35. Window.mui/MUIA_Window_RefWindow
  36. Window.mui/MUIA_Window_RootObject
  37. Window.mui/MUIA_Window_Screen
  38. Window.mui/MUIA_Window_ScreenTitle
  39. Window.mui/MUIA_Window_SizeGadget
  40. Window.mui/MUIA_Window_SizeRight
  41. Window.mui/MUIA_Window_Sleep
  42. Window.mui/MUIA_Window_Title
  43. Window.mui/MUIA_Window_TopEdge
  44. Window.mui/MUIA_Window_Width
  45. Window.mui/MUIA_Window_Window
  46. Window.mui/Window.mui
  47.  
  48.     Objects of window class are used to generate windows and
  49.     supply a place where MUI gadgets feel well. It handles
  50.     the complicated task of window resizing fully automatic,
  51.     you don't need to worry about that.
  52.  
  53.     Windows are children of an application, you cannot use
  54.     a window object without having a parent application
  55.     object. On the other side, the gadgets in a window
  56.     are children of the window, you cannot use MUI gadgets
  57.     without having a parent MUI window.
  58.  
  59.     Creating a window object does not mean to open it
  60.     instantly. This is done later by setting the window's
  61.     MUIA_Window_Open attribute. If your application has
  62.     several windows, the usual way is to create them all
  63.     at once at startup time and open/close it later
  64.     just by setting MUIA_Window_Open.
  65.  
  66.     There is no difference in talking to gadgets whether
  67.     their parent window is open or not. If you e.g. set
  68.     the contents of a string gadget in an open window,
  69.     the gadget will refresh immediately. If the window is
  70.     closed, the gadget just remembers its new setting
  71.     and displays it later.
  72. Window.mui/MUIM_Window_GetMenuCheck
  73.  
  74.     NAME
  75.     MUIM_Window_GetMenuCheck
  76.  
  77.     SYNOPSIS
  78.     DoMethod(obj,MUIM_Window_GetMenuCheck,ULONG MenuID);
  79.  
  80.     FUNCTION
  81.     Ask whether a checkmark menu item has its
  82.     checkmark set or cleared.
  83.  
  84.     INPUTS
  85.     MenuID - the value you wrote into the
  86.                  UserData field of struct NewMenu.
  87.  
  88.     SEE ALSO
  89.     MUIM_Window_SetMenuCheck, MUIA_Window_Menu
  90. Window.mui/MUIM_Window_GetMenuState
  91.  
  92.     NAME
  93.     MUIM_Window_GetMenuState
  94.  
  95.     SYNOPSIS
  96.     DoMethod(obj,MUIM_Window_GetMenuState,ULONG MenuID);
  97.  
  98.     FUNCTION
  99.     Ask whether a menu item is enabled or disabled.
  100.  
  101.     INPUTS
  102.     MenuID - the value you wrote into the
  103.                  UserData field of struct NewMenu.
  104.  
  105.     SEE ALSO
  106.     MUIM_Window_SetMenuState, MUIA_Window_Menu
  107. Window.mui/MUIM_Window_ScreenToBack
  108.  
  109.     NAME
  110.     MUIM_Window_ScreenToBack
  111.  
  112.     SYNOPSIS
  113.     DoMethod(obj,MUIM_Window_ScreenToBack,);
  114.  
  115.     FUNCTION
  116.     Put the window's screen to back. This command is
  117.     only valid when the window is opened.
  118.  
  119.     SEE ALSO
  120.     MUIM_Window_ScreenToFront, MUIM_Window_ToFront,
  121.     MUIM_Window_ToBack
  122. Window.mui/MUIM_Window_ScreenToFront
  123.  
  124.     NAME
  125.     MUIM_Window_ScreenToFront
  126.  
  127.     SYNOPSIS
  128.     DoMethod(obj,MUIM_Window_ScreenToFront,);
  129.  
  130.     FUNCTION
  131.     Put the window's screen to font. This command is
  132.     only valid when the window is opened.
  133.  
  134.     SEE ALSO
  135.     MUIM_Window_ScreenToBack, MUIM_Window_ToFront,
  136.     MUIM_Window_ToBack
  137. Window.mui/MUIM_Window_SetCycleChain
  138.  
  139.     NAME
  140.     MUIM_Window_SetCycleChain
  141.  
  142.     SYNOPSIS
  143.     DoMethod(obj,MUIM_Window_SetCycleChain,APTR o1, /* ,o2,...,NULL */);
  144.  
  145.     FUNCTION
  146.     Set the cycle chain for a window. To make MUI's keyboard
  147.     control work, you need to setup a chain of objects that
  148.     should be activatable with the tab key. This can be
  149.     any objects you wish, MUI supports complete keyboard
  150.     handling even for sliders or listviews.
  151.  
  152.     If you forget to set a cycle chain because you
  153.     are a mouse-man, you certainly will annoy some
  154.     users of your application!
  155.  
  156.     INPUTS
  157.     One or more objects, terminated with a NULL.
  158.  
  159.     EXAMPLE
  160.     DoMethod(window,MUIM_Window_SetCycleChain,
  161.        str1,str2,slide1,list,radio,cycle1,cycle2,NULL);
  162.  
  163.     SEE ALSO
  164.     MUIA_Window_ActiveObject
  165. Window.mui/MUIM_Window_SetMenuCheck
  166.  
  167.     NAME
  168.     MUIM_Window_SetMenuCheck
  169.  
  170.     SYNOPSIS
  171.     DoMethod(obj,MUIM_Window_SetMenuCheck,ULONG MenuID, LONG stat);
  172.  
  173.     FUNCTION
  174.     Set or clear the checkmark of a menu item.
  175.  
  176.     INPUTS
  177.     MenuID - the value you wrote into the
  178.                  UserData field of struct NewMenu.
  179.  
  180.     set    - TRUE to set checkmark, FALSE to clear
  181.  
  182.     SEE ALSO
  183.     MUIM_Window_GetMenuCheck, MUIA_Window_Menu,
  184. Window.mui/MUIM_Window_SetMenuState
  185.  
  186.     NAME
  187.     MUIM_Window_SetMenuState
  188.  
  189.     SYNOPSIS
  190.     DoMethod(obj,MUIM_Window_SetMenuState,ULONG MenuID, LONG stat);
  191.  
  192.     FUNCTION
  193.     Enable or disable a menu item.
  194.  
  195.     INPUTS
  196.     MenuID - the value you wrote into the
  197.                  UserData field of struct NewMenu.
  198.  
  199.     set    - TRUE to enable item, FALSE to disable.
  200.  
  201.     SEE ALSO
  202.     MUIM_Window_GetMenuState, MUIA_Window_Menu,
  203. Window.mui/MUIM_Window_ToBack
  204.  
  205.     NAME
  206.     MUIM_Window_ToBack
  207.  
  208.     SYNOPSIS
  209.     DoMethod(obj,MUIM_Window_ToBack,);
  210.  
  211.     FUNCTION
  212.     Put the window to back. When the window is not currently open,
  213.     this command does simply nothing.
  214.  
  215.     SEE ALSO
  216.     MUIM_Window_ToFront, MUIM_Window_ScreenToFront,
  217.     MUIM_Window_ScreenToBack
  218. Window.mui/MUIM_Window_ToFront
  219.  
  220.     NAME
  221.     MUIM_Window_ToFront
  222.  
  223.     SYNOPSIS
  224.     DoMethod(obj,MUIM_Window_ToFront,);
  225.  
  226.     FUNCTION
  227.     Put the window to front. When the window is not currently open,
  228.     this command does simply nothing.
  229.  
  230.     SEE ALSO
  231.     MUIM_Window_ToBack, MUIM_Window_ScreenToFront,
  232.     MUIM_Window_ScreenToBack
  233. Window.mui/MUIA_Window_Activate
  234.  
  235.     NAME
  236.     MUIA_Window_Activate -- [ISG], BOOL
  237.  
  238.     FUNCTION
  239.     Setting this to TRUE will activate the window.
  240.     Setting this to FALSE has no effect.
  241.     The attribute will change whenever the user
  242.     activates/deactivates the window.
  243.  
  244.     Specifying FALSE at object creation time will make
  245.     the window open in an inactive state.
  246. Window.mui/MUIA_Window_ActiveObject
  247.  
  248.     NAME
  249.     MUIA_Window_ActiveObject -- [.SG], Object *
  250.  
  251.     SPECIAL INPUTS
  252.     MUIV_Window_ActiveObject_None
  253.     MUIV_Window_ActiveObject_Next
  254.     MUIV_Window_ActiveObject_Prev
  255.  
  256.     FUNCTION
  257.     Set the active object in a window as if the user
  258.     would have activated it with the tab key. The
  259.     object has to be in the cycle chain for this
  260.     command to work.
  261.  
  262.     EXAMPLE
  263.     set(window,MUIA_Window_ActiveObject,okaybutton);
  264.  
  265.     SEE ALSO
  266.     MUIM_Window_SetCycleChain
  267. Window.mui/MUIA_Window_AltHeight
  268.  
  269.     NAME
  270.     MUIA_Window_AltHeight -- [I.G], LONG
  271.  
  272.     SPECIAL INPUTS
  273.     MUIV_Window_AltHeight_MinMax(p)
  274.     MUIV_Window_AltHeight_Visible(p)
  275.     MUIV_Window_AltHeight_Screen(p)
  276.     MUIV_Window_AltHeight_Scaled
  277.  
  278.     FUNCTION
  279.     Specify the alternate (zoomed) height of a window.
  280.     If not present, the alternate height will be the
  281.     minimum height.
  282.  
  283.     SEE ALSO
  284.     MUIA_Window_Height, MUIA_Window_AltWidth
  285. Window.mui/MUIA_Window_AltLeftEdge
  286.  
  287.     NAME
  288.     MUIA_Window_AltLeftEdge -- [I.G], LONG
  289.  
  290.     SPECIAL INPUTS
  291.     MUIV_Window_AltLeftEdge_Centered
  292.     MUIV_Window_AltLeftEdge_Moused
  293.     MUIV_Window_AltLeftEdge_NoChange
  294.  
  295.     FUNCTION
  296.     Specify the alternate (zoomed) left position of
  297.     a window. This defaults to the standard left
  298.     position.
  299.  
  300.     SEE ALSO
  301.     MUIA_Window_LeftEdge, MUIA_Window_AltTopEdge
  302. Window.mui/MUIA_Window_AltTopEdge
  303.  
  304.     NAME
  305.     MUIA_Window_AltTopEdge -- [I.G], LONG
  306.  
  307.     SPECIAL INPUTS
  308.     MUIV_Window_AltTopEdge_Centered
  309.     MUIV_Window_AltTopEdge_Moused
  310.     MUIV_Window_AltTopEdge_Delta(p)
  311.     MUIV_Window_AltTopEdge_NoChange
  312.  
  313.     FUNCTION
  314.     Specify the alternate (zoomed) top position of
  315.     a window. This defaults to the standard top
  316.     position.
  317.  
  318.     SEE ALSO
  319.     MUIA_Window_TopEdge, MUIA_Window_AltLeftEdge
  320. Window.mui/MUIA_Window_AltWidth
  321.  
  322.     NAME
  323.     MUIA_Window_AltWidth -- [I.G], LONG
  324.  
  325.     SPECIAL INPUTS
  326.     MUIV_Window_AltWidth_MinMax(p)
  327.     MUIV_Window_AltWidth_Visible(p)
  328.     MUIV_Window_AltWidth_Screen(p)
  329.     MUIV_Window_AltWidth_Scaled
  330.  
  331.     FUNCTION
  332.     Specify the alternate (zoomed) width of a window.
  333.     If not present, the alternate width will be the
  334.     minimum width.
  335.  
  336.     SEE ALSO
  337.     MUIA_Window_Width, MUIA_Window_AltHeight
  338. Window.mui/MUIA_Window_AppWindow
  339.  
  340.     NAME
  341.     MUIA_Window_AppWindow -- [I..], BOOL
  342.  
  343.     FUNCTION
  344.     Setting this attribute to TRUE will make this window an
  345.     AppWindow, the user will be able to drop icons on it.
  346.     You can hear about these events by listening to the
  347.     MUIA_AppMessage attribute.
  348.  
  349.     SEE ALSO
  350.     MUIA_AppMessage, MUIA_Application_DropObject
  351. Window.mui/MUIA_Window_Backdrop
  352.  
  353.     NAME
  354.     MUIA_Window_Backdrop -- [I..], BOOL
  355.  
  356.     FUNCTION
  357.     Make the window a backdrop window.
  358. Window.mui/MUIA_Window_Borderless
  359.  
  360.     NAME
  361.     MUIA_Window_Borderless -- [I..], BOOL
  362.  
  363.     FUNCTION
  364.     Make the window borderless.
  365. Window.mui/MUIA_Window_CloseGadget
  366.  
  367.     NAME
  368.     MUIA_Window_CloseGadget -- [I..], BOOL
  369.  
  370.     FUNCTION
  371.     Set this to FALSE and your window will not
  372.     have a close gadget.
  373. Window.mui/MUIA_Window_CloseRequest
  374.  
  375.     NAME
  376.     MUIA_Window_CloseRequest -- [..G], BOOL
  377.  
  378.     FUNCTION
  379.     When the user hits a windows close gadget, the
  380.     window isn't closed immediately. Instead MUI only
  381.     sets this attribute to TRUE to allow your application
  382.     to react.
  383.  
  384.     Usually, you will setup a notification that automatically
  385.     closes the window when a close request appears, but you
  386.     could e.g. pop up a confirmation requester or do some
  387.     other things first.
  388.  
  389.     EXAMPLE
  390.     /* automagically close a window     */
  391.     /* when the close gadget is pressed */
  392.  
  393.     DoMethod(window,MUIM_Notify,
  394.        MUIA_Window_CloseRequest, TRUE,
  395.        window,3,MUIM_Set,MUIA_Window_Open,0);
  396.  
  397.     SEE ALSO
  398.     MUIA_Window_Open
  399. Window.mui/MUIA_Window_DefaultObject
  400.  
  401.     NAME
  402.     MUIA_Window_DefaultObject -- [ISG], Object *
  403.  
  404.     FUNCTION
  405.     The default object in a window receives keyboard input
  406.     as long as no other object is active. Good candidates
  407.     for default objects are e.g. lonely listviews. Making
  408.     such a listview the default object will allow the user
  409.     to control it immediately without the need of several
  410.     tab strokes for activation.
  411.  
  412.     SEE ALSO
  413.     MUIA_Window_ActiveObject
  414. Window.mui/MUIA_Window_DepthGadget
  415.  
  416.     NAME
  417.     MUIA_Window_DepthGadget -- [I..], BOOL
  418.  
  419.     FUNCTION
  420.     Enable or disable the depth gadget. Defaults to TRUE.
  421.     There is no good reason to use this tag.
  422. Window.mui/MUIA_Window_DragBar
  423.  
  424.     NAME
  425.     MUIA_Window_DragBar -- [I..], BOOL
  426.  
  427.     FUNCTION
  428.     Tell MUI to give your window a dragbar.
  429.  
  430.     Defaults to TRUE.
  431.  
  432.     There is no good reason to disable the dragbar!
  433. Window.mui/MUIA_Window_Height
  434.  
  435.     NAME
  436.     MUIA_Window_Height -- [I.G], LONG
  437.  
  438.     SPECIAL INPUTS
  439.     MUIV_Window_Height_MinMax(p)
  440.     MUIV_Window_Height_Visible(p)
  441.     MUIV_Window_Height_Screen(p)
  442.     MUIV_Window_Height_Scaled
  443.     MUIV_Window_Height_Default
  444.  
  445.     FUNCTION
  446.     Specify the height of a window. Usually, you won't give
  447.     a pixel value here but instead use one of the following
  448.     magic macros:
  449.  
  450.     MUIV_Window_Height_Default:
  451.        calculated from objects default sizes.
  452.  
  453.     MUIV_Window_Height_MinMax(0..100):
  454.        somewhere between the minimum height (0) and the
  455.        maximum height (100) of your window.
  456.  
  457.     MUIV_Window_Height_Visible(1..100):
  458.        percentage of the screens visible height.
  459.  
  460.     MUIV_Window_Height_Screen(1..100):
  461.        percentage of the screens total height.
  462.  
  463.     MUIV_Window_Height_Scaled:
  464.        height will be adjusted so that
  465.        width : height == minimum width : minimum height.
  466.        Note that a windows width and height may not
  467.        both be scaled.
  468.  
  469.     Default for this tag is MUIV_Window_Height_Default.
  470.  
  471.     As long as your window has a window id (MUIA_Window_ID),
  472.     choosing a size is not that important. MUI will always
  473.     remember a windows last position and size and these
  474.     values will simply override your settings. Positioning
  475.     and sizing should be completely under user control,
  476.     a programmer doesn't need to worry about it.
  477.  
  478.     SEE ALSO
  479.     MUIA_Window_Width, MUIA_Window_ID
  480. Window.mui/MUIA_Window_ID
  481.  
  482.     NAME
  483.     MUIA_Window_ID -- [ISG], ULONG
  484.  
  485.     FUNCTIONS
  486.     For most of your windows, you should define a longword
  487.     as id value. Only a window with an id is able to
  488.     remember its size and position.
  489.  
  490.     Additionally, when you use an ascii id (e.g. 'MAIN'),
  491.     your window can be controlled from ARexx.
  492.  
  493.     Of course all windows of your application must have
  494.     unique ids.
  495.  
  496.     SEE ALSO
  497.     MUIA_Window_LeftEdge
  498. Window.mui/MUIA_Window_InputEvent
  499.  
  500.     NAME
  501.     MUIA_Window_InputEvent -- [..G], struct InputEvent *
  502.  
  503.     FUNCTION
  504.     This attribute gets set whenever your window receives
  505.     a rawkey input event. You can react on this by creating
  506.     a notification event containing a standard
  507.     commodities.library input description string.
  508.  
  509.     EXAMPLE
  510.     DoMethod(window, MUIM_Notify,
  511.        MUIA_Window_InputEvent, "control p",
  512.        txobj, 3,
  513.        MUIM_Set, MUIA_Text_Contents, "user pressed ctrl p");
  514. Window.mui/MUIA_Window_LeftEdge
  515.  
  516.     NAME
  517.     MUIA_Window_LeftEdge -- [I.G], LONG
  518.  
  519.     SPECIAL INPUTS
  520.     MUIV_Window_LeftEdge_Centered
  521.     MUIV_Window_LeftEdge_Moused
  522.  
  523.     FUNCTION
  524.     Specify the left edge of a window. Usually, you shouldn't
  525.     define a pixel value here but instead use one of the
  526.     following macros:
  527.  
  528.     MUIV_Window_LeftEdge_Centered:
  529.        window appears centered on the visible area of screen.
  530.  
  531.     MUIV_Window_LeftEdge_Moused
  532.        window appears centered under the mouse pointer.
  533.  
  534.     Default for this tag is MUIV_Window_LeftEdge_Centered.
  535.  
  536.     As long as your window has a window id (MUIA_Window_ID),
  537.     choosing a position is not that important. MUI will always
  538.     remember a windows last position and size and these
  539.     values will simply override your settings. Positioning
  540.     and sizing should be completely under user control,
  541.     a programmer doesn't need to worry about it.
  542.  
  543.     SEE ALSO
  544.     MUIA_Window_TopEdge, MUIA_Window_ID
  545. Window.mui/MUIA_Window_Menu
  546.  
  547.     NAME
  548.     MUIA_Window_Menu -- [I..], struct NewMenu *
  549.  
  550.     SPECIAL INPUTS
  551.     MUIV_Window_Menu_NoMenu
  552.  
  553.     FUNCTION
  554.     Set a menu for this window. Normally, you would
  555.     use MUIA_Application_Menu to set the same menu
  556.     for all subwindows of your application.
  557.     MUIA_Window_Menu will override a possible
  558.     MUIA_Application_Menu setting.
  559.  
  560.     For details about menu handling, please see
  561.     MUIA_Application_Menu.
  562.  
  563.     A value of MUIV_Window_Menu_NoMenu for this
  564.     tag means that you want no menu for this window,
  565.     even if you have a global one for your application.
  566.  
  567.     SEE ALSO
  568.     MUIA_Application_Menu, MUIA_Window_NoMenus
  569. Window.mui/MUIA_Window_NoMenus
  570.  
  571.     NAME
  572.     MUIA_Window_NoMenus -- [.S.], BOOL
  573.  
  574.     FUNCTION
  575.     Temporarily disable the menu strip of a window.
  576.  
  577.     SEE ALSO
  578.     MUIA_Window_Menu
  579. Window.mui/MUIA_Window_Open
  580.  
  581.     NAME
  582.     MUIA_Window_Open -- [.SG], BOOL
  583.  
  584.     FUNCTION
  585.     This little attribute can be used to open and close
  586.     a window. When opening a window, MUI does lots of
  587.     stuff to calculate sizes and positions of all
  588.     gadgets. Minimum and maximum window sizes will be
  589.     adjusted automatically.
  590.  
  591.     When the minimum size of a window is too big to fit
  592.     on the screen, MUI tries to reduce font sizes and
  593.     does a new calculation. You should always design
  594.     your windows to fit on a 640*200 screen with
  595.     all fonts set to topaz/8.
  596.  
  597.     When a window is closed (and you specified a
  598.     MUIA_Window_ID), MUI remembers its position
  599.     and size and uses these values during the next
  600.     opening.
  601.  
  602.     After setting MUIA_Window_Open to TRUE, you should
  603.     test if MUI was able to open the window by getting
  604.     the attribute again. If you don't and if this was
  605.     the only window of your application, the user won't
  606.     be able to do any input and your application will
  607.     seem to hang.
  608.  
  609.     EXAMPLE
  610.     set(window,MUIA_Window_Open,TRUE);
  611.     get(window,MUIA_Window_Open,&open);
  612.     if (!open)
  613.     {
  614.        MUI_Request(app,0,0,0,"Ok","Failed to open window.");
  615.        exit(20);
  616.     }
  617.  
  618.     SEE ALSO
  619.     MUIA_Window_RootObject
  620. Window.mui/MUIA_Window_PublicScreen
  621.  
  622.     NAME
  623.     MUIA_Window_PublicScreen -- [ISG], STRPTR
  624.  
  625.     FUNCTION
  626.     Force the window to appear on the public screen who's name
  627.     is specified by this attribute. This tag overrides the
  628.     user preferences setting and is overridden by
  629.     MUIA_Window_Screen.
  630.  
  631.     Please use this tag sparely, overriding user prefs is
  632.     not a good idea!
  633.  
  634.     SEE ALSO
  635.     MUIA_Window_Screen
  636. Window.mui/MUIA_Window_RefWindow
  637.  
  638.     NAME
  639.     MUIA_Window_RefWindow -- [IS.], Object *
  640.  
  641.     FUNCTION
  642.     Setting MUIA_Window_RefWindow to another MUI window
  643.     object will make the left and top position relative
  644.     to this reference window. Using the
  645.     MUIA_Window_Left(Top)Edge_Centered tag, you can easily
  646.     open one window within another.
  647.  
  648.     Note that if your window has an id, the window will
  649.     remember its last position and reopen there. Thus,
  650.     this tag is only useful if you omit MUIA_Window_ID,
  651.     maybe for some small requester windows.
  652.  
  653.     SEE ALSO
  654.     MUIA_Window_ID, MUIA_Window_LeftEdge
  655. Window.mui/MUIA_Window_RootObject
  656.  
  657.     NAME
  658.     MUIA_Window_RootObject -- [I..], Object *
  659.  
  660.     FUNCTION
  661.     This is a pointer to a MUI object and defines the
  662.     contents of your window. Usually, this root object
  663.     will be of class MUIC_Group since you surely want to
  664.     have more than one gadget.
  665.  
  666.     The root object is treated as child of a window
  667.     and will be disposed when the window is disposed.
  668.     Note that windows can only have one child.
  669.  
  670.     Although you may create a window without root object,
  671.     you have to set one before the window is openend!
  672.  
  673.     EXAMPLE
  674.     win = WindowObject, MUIA_Window_RootObject,
  675.        VGroup,
  676.           Child, ...,
  677.           Child, ...,
  678.           End,
  679.        End;
  680.  
  681.     SEE ALSO
  682.     MUIA_Window_Open
  683. Window.mui/MUIA_Window_Screen
  684.  
  685.     NAME
  686.     MUIA_Window_Screen -- [ISG], struct Screen *
  687.  
  688.     FUNCTION
  689.     You can get a pointer to the parent screen of a window by 
  690.     getting this attribute. The result will be NULL when the
  691.     window is currently closed.
  692.  
  693.     Specifying MUIA_Window_Screen at object creation time or
  694.     with a SetAttrs() call allows you to explicitly tell MUI
  695.     on which screen the window should be opened. You normally
  696.     won't need this feature and leave the decision about
  697.     screens to the users preferences setting.
  698.  
  699.     SEE ALSO
  700.     MUIA_Window_PublicScreen, MUIA_Window_Window
  701. Window.mui/MUIA_Window_ScreenTitle
  702.  
  703.     NAME
  704.     MUIA_Window_ScreenTitle -- [ISG], STRPTR
  705.  
  706.     FUNCTION
  707.     This text will appear in the screens title bar
  708.     when the window is active.
  709.  
  710.     SEE ALSO
  711.     MUIA_Window_Title
  712. Window.mui/MUIA_Window_SizeGadget
  713.  
  714.     NAME
  715.     MUIA_Window_SizeGadget -- [I..], BOOL
  716.  
  717.     FUNCTION
  718.     Tell MUI if you want a sizing gadget for this window.
  719.     Usually you won't need this attribute since MUI
  720.     will automatically disable the sizing gadget when
  721.     your window is not sizeable because of your gadget
  722.     layout.
  723. Window.mui/MUIA_Window_SizeRight
  724.  
  725.     NAME
  726.     MUIA_Window_SizeRight -- [I..], BOOL
  727.  
  728.     FUNCTION
  729.     When set to TRUE, the size gadget will reside
  730.     in the right window border.
  731. Window.mui/MUIA_Window_Sleep
  732.  
  733.     NAME
  734.     MUIA_Window_Sleep -- [.SG], BOOL
  735.  
  736.     FUNCTION
  737.     This attribute can be used to put a window to sleep.
  738.     The window gets disabled and a busy pointer appears.
  739.  
  740.     The attribute contains a nesting count, if you tell
  741.     your window to sleep twice, you will have to tell
  742.     it to wake up twice too.
  743.  
  744.     A sleeping window cannot be resized.
  745.  
  746.     SEE ALSO
  747.     MUIA_Application_Sleep
  748. Window.mui/MUIA_Window_Title
  749.  
  750.     NAME
  751.     MUIA_Window_Title -- [ISG], STRPTR
  752.  
  753.     FUNCTION
  754.     Specify the title of a window.
  755.  
  756.     SEE ALSO
  757.     MUIA_Window_ScreenTitle
  758. Window.mui/MUIA_Window_TopEdge
  759.  
  760.     NAME
  761.     MUIA_Window_TopEdge -- [I.G], LONG
  762.  
  763.     SPECIAL INPUTS
  764.     MUIV_Window_TopEdge_Centered
  765.     MUIV_Window_TopEdge_Moused
  766.     MUIV_Window_TopEdge_Delta(p)
  767.  
  768.     FUNCTION
  769.     Specify the top edge of a window. Usually, you shouldn't
  770.     define a pixel value here but instead use one of the
  771.     following macros:
  772.  
  773.     MUIV_Window_TopEdge_Centered:
  774.        window appears centered on the visible area of screen.
  775.  
  776.     MUIV_Window_TopEdge_Moused
  777.        window appears centered under the mouse pointer.
  778.  
  779.     MUIV_Window_TopEdge_Delta(p)
  780.        window appears p pixels below the screens title bar.
  781.  
  782.     Default for this tag is MUIV_Window_TopEdge_Centered.
  783.  
  784.     As long as your window has a window id (MUIA_Window_ID),
  785.     choosing a position is not that important. MUI will always
  786.     remember a windows last position and size and these
  787.     values will simply override your settings. Positioning
  788.     and sizing should be completely under user control,
  789.     a programmer doesn't need to worry about it.
  790.  
  791.     SEE ALSO
  792.     MUIA_Window_LeftEdge, MUIA_Window_ID
  793. Window.mui/MUIA_Window_Width
  794.  
  795.     NAME
  796.     MUIA_Window_Width -- [I.G], LONG
  797.  
  798.     SPECIAL INPUTS
  799.     MUIV_Window_Width_MinMax(p)
  800.     MUIV_Window_Width_Visible(p)
  801.     MUIV_Window_Width_Screen(p)
  802.     MUIV_Window_Width_Scaled
  803.     MUIV_Window_Width_Default
  804.  
  805.     FUNCTION
  806.     Specify the width of a window. Usually, you won't give
  807.     a pixel value here but instead use one of the following
  808.     magic macros:
  809.  
  810.     MUIV_Window_Width_Default:
  811.        calculated from objects default sizes.
  812.  
  813.     MUIV_Window_Width_MinMax(0..100):
  814.        somewhere between the minimum width (0) and the
  815.        maximum width (100) of your window.
  816.  
  817.     MUIV_Window_Width_Visible(1..100):
  818.        percentage of the screens visible width.
  819.  
  820.     MUIV_Window_Width_Screen(1..100):
  821.        percentage of the screens total width.
  822.  
  823.     MUIV_Window_Width_Scaled:
  824.        width will be adjusted so that
  825.        width : height == minimum width : minimum height.
  826.        Note that a windows width and height may not
  827.        both be scaled.
  828.  
  829.     Default for this tag is MUIV_Window_Width_Default.
  830.  
  831.     As long as your window has a window id (MUIA_Window_ID),
  832.     choosing a size is not that important. MUI will always
  833.     remember a windows last position and size and these
  834.     values will simply override your settings. Positioning
  835.     and sizing should be completely under user control,
  836.     a programmer doesn't need to worry about it.
  837.  
  838.     SEE ALSO
  839.     MUIA_Window_Height, MUIA_Window_ID
  840. Window.mui/MUIA_Window_Window
  841.  
  842.     NAME
  843.     MUIA_Window_Window -- [..G], struct Window *
  844.  
  845.     FUNCTION
  846.     When your window is open, you can obtain a pointer
  847.     to the intuition Window structure with this tag
  848.     and use it e.g. in an asl.library requester call.
  849.  
  850.     Since the user can close your window any time
  851.     (e.g. iconification), you must be prepared to
  852.     receive a NULL pointer as result.
  853.  
  854.     SEE ALSO
  855.     MUIA_Window_Screen
  856.